ostree-repo-finder: Clarify immutability after construction

I think this was the intention, but I forgot to document it.

Signed-off-by: Philip Withnall <withnall@endlessm.com>
Closes: #1863
Approved by: mwleeds

diff --git a/src/libostree/ostree-repo-finder.h b/src/libostree/ostree-repo-finder.h
index 7c9be300a68298303ff5fd82d7af5821d04b3ebf..f9c26199e2903d00e46e2cda0514b503b501f4f8 100644 (file)
--- a/src/libostree/ostree-repo-finder.h
+++ b/src/libostree/ostree-repo-finder.h
@@ -111,6 +111,8 @@ GPtrArray *ostree_repo_finder_resolve_all_finish (GAsyncResult  *result,
  * which allow ostree_repo_pull_from_remotes_async() (for example) to prioritise
  * how to pull the refs.
  *
+ * An #OstreeRepoFinderResult is immutable after construction.
+ *
  * The @priority is used as one input of many to ordering functions like
  * ostree_repo_finder_result_compare().
  *